Node / ReticulumProjects / MeshChatX.git / files / meshchatx / src / backend / interface_port_check.py

Displaying Raw • Download

T8b949e# SPDX-License-Identifier: 0BSD AND MIT

T8b949e"""Helpers for validating that user supplied interface ports are usable.

These helpers attempt to bind to the requested port on the requested host so

that the UI can warn the operator before saving a configuration that would

fail to come up after restart. The checks are intentionally best-effort: they

only catch ports that are *currently* in use by another process, they do not

guarantee that the port will still be free at restart time.

"""

Tff7b72from T7ee787__future__ Tff7b72import Te6edf3annotations

Tff7b72import T7ee787contextlib

Tff7b72import T7ee787errno

Tff7b72import T7ee787socket

Te6edf3_PORT_IN_USE_ERRNOS Tff7b72= Tb4b4b4{

Te6edf3errnoTff7b72.Td2a8ffEADDRINUSETb4b4b4,

Te6edf3errnoTff7b72.Td2a8ffEACCESTb4b4b4,

Te6edf3errnoTff7b72.Td2a8ffEADDRNOTAVAILTb4b4b4,

Tb4b4b4}

Tff7b72def Td2a8ff_normalize_hostTb4b4b4(Te6edf3hostTb4b4b4: Tffa657str Tff7b72| Tff7b72NoneTb4b4b4) Tff7b72-Tff7b72> Tffa657strTb4b4b4:

T8b949e"""Return a host string that is safe to call getaddrinfo with."""

Tff7b72if Te6edf3host Tff7b72is Tff7b72NoneTb4b4b4:

Tff7b72return Ta5d6ff"Ta5d6ff"

Te6edf3host Tff7b72= Tffa657strTb4b4b4(Te6edf3hostTb4b4b4)Tff7b72.Td2a8ffstripTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3host Tff7b72== Ta5d6ff"Ta5d6ff" Tff7b72or Te6edf3host Tff7b72in Tb4b4b4{Ta5d6ff"Ta5d6ff*Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff0.0.0.0Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff::Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff[::]Ta5d6ff"Tb4b4b4}Tb4b4b4: T8b949e# noqa: S104

Tff7b72return Ta5d6ff"Ta5d6ff"

Tff7b72return Te6edf3host

Tff7b72def Td2a8ff_coerce_portTb4b4b4(Te6edf3portTb4b4b4) Tff7b72-Tff7b72> Tffa657int Tff7b72| Tff7b72NoneTb4b4b4:

Tff7b72if Te6edf3port Tff7b72is Tff7b72None Tff7b72or Te6edf3port Tff7b72== Ta5d6ff"Ta5d6ff"Tb4b4b4:

Tff7b72return Tff7b72None

Tff7b72tryTb4b4b4:

Te6edf3value Tff7b72= Tffa657intTb4b4b4(Te6edf3portTb4b4b4)

Tff7b72except Tb4b4b4(Tf85149TypeErrorTb4b4b4, Tf85149ValueErrorTb4b4b4)Tb4b4b4:

Tff7b72return Tff7b72None

Tff7b72if Te6edf3value Tff7b72< T79c0ff0 Tff7b72or Te6edf3value Tff7b72> T79c0ff65535Tb4b4b4:

Tff7b72return Tff7b72None

Tff7b72return Te6edf3value

Tff7b72def Td2a8ffis_port_in_useTb4b4b4(Te6edf3hostTb4b4b4: Tffa657str Tff7b72| Tff7b72NoneTb4b4b4, Te6edf3portTb4b4b4, Tff7b72*Tb4b4b4, Te6edf3kindTb4b4b4: Tffa657str Tff7b72= Ta5d6ff"Ta5d6fftcpTa5d6ff"Tb4b4b4) Tff7b72-Tff7b72> Tffa657boolTb4b4b4:

T8b949e"""Return True when the given host:port is already bound.

kind may be "tcp" or "udp". Unknown values are treated as TCP.

The helper resolves the supplied host (falling back to INADDR_ANY) and

tries to bind a fresh socket. EADDRINUSE/EACCES/EADDRNOTAVAIL

are reported as "in use", any other exception bubbles up as False so

that we never block save flows because of a transient resolution glitch.

"""

Te6edf3coerced_port Tff7b72= Te6edf3_coerce_portTb4b4b4(Te6edf3portTb4b4b4)

Tff7b72if Te6edf3coerced_port Tff7b72is Tff7b72None Tff7b72or Te6edf3coerced_port Tff7b72== T79c0ff0Tb4b4b4:

Tff7b72return Tff7b72False

Te6edf3sock_kind Tff7b72= Te6edf3socketTff7b72.Td2a8ffSOCK_DGRAM Tff7b72if Tffa657strTb4b4b4(Te6edf3kindTb4b4b4)Tff7b72.Td2a8fflowerTb4b4b4(Tb4b4b4) Tff7b72== Ta5d6ff"Ta5d6ffudpTa5d6ff" Tff7b72else Te6edf3socketTff7b72.Td2a8ffSOCK_STREAM

Te6edf3normalized Tff7b72= Te6edf3_normalize_hostTb4b4b4(Te6edf3hostTb4b4b4)

Te6edf3candidatesTb4b4b4: Tffa657listTb4b4b4[Tffa657tupleTb4b4b4[Te6edf3socketTff7b72.Td2a8ffAddressFamilyTb4b4b4, Tffa657strTb4b4b4]Tb4b4b4] Tff7b72= Tb4b4b4[Tb4b4b4]

Tff7b72if Te6edf3normalized Tff7b72== Ta5d6ff"Ta5d6ff"Tb4b4b4:

Te6edf3candidatesTff7b72.Td2a8ffappendTb4b4b4(Tb4b4b4(Te6edf3socketTff7b72.Td2a8ffAF_INETTb4b4b4, Ta5d6ff"Ta5d6ff0.0.0.0Ta5d6ff"Tb4b4b4)Tb4b4b4) T8b949e# noqa: S104

Te6edf3candidatesTff7b72.Td2a8ffappendTb4b4b4(Tb4b4b4(Te6edf3socketTff7b72.Td2a8ffAF_INET6Tb4b4b4, Ta5d6ff"Ta5d6ff::Ta5d6ff"Tb4b4b4)Tb4b4b4)

Tff7b72elseTb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3infos Tff7b72= Te6edf3socketTff7b72.Td2a8ffgetaddrinfoTb4b4b4(

Te6edf3normalizedTb4b4b4,

Te6edf3coerced_portTb4b4b4,

Tffa657typeTff7b72=Te6edf3sock_kindTb4b4b4,

Tb4b4b4)

Tff7b72except Tf85149OSErrorTb4b4b4:

Tff7b72return Tff7b72False

Te6edf3seenTb4b4b4: Tffa657setTb4b4b4[Tffa657tupleTb4b4b4[Te6edf3socketTff7b72.Td2a8ffAddressFamilyTb4b4b4, Tffa657strTb4b4b4]Tb4b4b4] Tff7b72= Tffa657setTb4b4b4(Tb4b4b4)

Tff7b72for Te6edf3info Tff7b72in Te6edf3infosTb4b4b4:

Te6edf3family Tff7b72= Te6edf3infoTb4b4b4[T79c0ff0Tb4b4b4]

Tff7b72if Te6edf3family Tff7b72not Tff7b72in Tb4b4b4(Te6edf3socketTff7b72.Td2a8ffAF_INETTb4b4b4, Te6edf3socketTff7b72.Td2a8ffAF_INET6Tb4b4b4)Tb4b4b4:

Tff7b72continue

Te6edf3address Tff7b72= Tffa657strTb4b4b4(Te6edf3infoTb4b4b4[T79c0ff4Tb4b4b4]Tb4b4b4[T79c0ff0Tb4b4b4]Tb4b4b4)

Te6edf3key Tff7b72= Tb4b4b4(Te6edf3familyTb4b4b4, Te6edf3addressTb4b4b4)

Tff7b72if Te6edf3key Tff7b72in Te6edf3seenTb4b4b4:

Tff7b72continue

Te6edf3seenTff7b72.Td2a8ffaddTb4b4b4(Te6edf3keyTb4b4b4)

Te6edf3candidatesTff7b72.Td2a8ffappendTb4b4b4(Te6edf3keyTb4b4b4)

Tff7b72for Te6edf3familyTb4b4b4, Te6edf3address Tff7b72in Te6edf3candidatesTb4b4b4:

Tff7b72with Te6edf3contextlibTff7b72.Td2a8ffclosingTb4b4b4(Te6edf3socketTff7b72.Td2a8ffsocketTb4b4b4(Te6edf3familyTb4b4b4, Te6edf3sock_kindTb4b4b4)Tb4b4b4) Tff7b72as Te6edf3sockTb4b4b4:

Tff7b72tryTb4b4b4:

Tff7b72if Te6edf3sock_kind Tff7b72== Te6edf3socketTff7b72.Td2a8ffSOCK_STREAMTb4b4b4:

Te6edf3sockTff7b72.Td2a8ffsetsockoptTb4b4b4(Te6edf3socketTff7b72.Td2a8ffSOL_SOCKETTb4b4b4, Te6edf3socketTff7b72.Td2a8ffSO_REUSEADDRTb4b4b4, T79c0ff1Tb4b4b4)

Te6edf3sockTff7b72.Td2a8ffbindTb4b4b4(Tb4b4b4(Te6edf3addressTb4b4b4, Te6edf3coerced_portTb4b4b4)Tb4b4b4)

Tff7b72except Tf85149OSError Tff7b72as Te6edf3excTb4b4b4:

Tff7b72if Te6edf3excTff7b72.Td2a8fferrno Tff7b72in Te6edf3_PORT_IN_USE_ERRNOSTb4b4b4:

Tff7b72return Tff7b72True

Tff7b72continue

Tff7b72return Tff7b72False

Tff7b72def Td2a8ffdescribe_port_conflictTb4b4b4(

Te6edf3hostTb4b4b4: Tffa657str Tff7b72| Tff7b72NoneTb4b4b4,

Te6edf3portTb4b4b4,

Tff7b72*Tb4b4b4,

Te6edf3kindTb4b4b4: Tffa657str Tff7b72= Ta5d6ff"Ta5d6fftcpTa5d6ff"Tb4b4b4,

Te6edf3interface_nameTb4b4b4: Tffa657str Tff7b72| Tff7b72None Tff7b72= Tff7b72NoneTb4b4b4,

Tb4b4b4) Tff7b72-Tff7b72> Tffa657strTb4b4b4:

T8b949e"""Build a user-facing message describing a port conflict."""

Te6edf3coerced_port Tff7b72= Te6edf3_coerce_portTb4b4b4(Te6edf3portTb4b4b4)

Te6edf3host_label Tff7b72= Te6edf3_normalize_hostTb4b4b4(Te6edf3hostTb4b4b4) Tff7b72or Ta5d6ff"Ta5d6ff0.0.0.0Ta5d6ff" T8b949e# noqa: S104

Te6edf3name_part Tff7b72= Ta5d6fffTa5d6ff'Ta5d6ff for interface Ta5d6ff"Tffd700{Te6edf3interface_nameTffd700}Ta5d6ff"Ta5d6ff' Tff7b72if Te6edf3interface_name Tff7b72else Ta5d6ff"Ta5d6ff"

Te6edf3proto Tff7b72= Tffa657strTb4b4b4(Te6edf3kindTb4b4b4)Tff7b72.Td2a8ffupperTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3coerced_port Tff7b72is Tff7b72NoneTb4b4b4:

Tff7b72return Tb4b4b4(

Ta5d6fffTa5d6ff"Ta5d6ffThe configured Tffd700{Te6edf3protoTffd700}Ta5d6ff portTffd700{Te6edf3name_partTffd700}Ta5d6ff is invalid. Ta5d6ff"

Ta5d6ff"Ta5d6ffPlease pick a value between 1 and 65535.Ta5d6ff"

Tb4b4b4)

Tff7b72return Tb4b4b4(

Ta5d6fffTa5d6ff"Ta5d6ffThe Tffd700{Te6edf3protoTffd700}Ta5d6ff port Tffd700{Te6edf3coerced_portTffd700}Ta5d6ff on Tffd700{Te6edf3host_labelTffd700}Ta5d6ff is already in Ta5d6ff"

Ta5d6fffTa5d6ff"Ta5d6ffuse by another processTffd700{Te6edf3name_partTffd700}Ta5d6ff. Stop the conflicting process Ta5d6ff"

Ta5d6ff"Ta5d6ffor pick a different port.Ta5d6ff"

Tb4b4b4)